Skip to content

feat!: Include plan return values in WorkerEvents#1357

Open
tpoliaw wants to merge 5 commits intomainfrom
plan-result
Open

feat!: Include plan return values in WorkerEvents#1357
tpoliaw wants to merge 5 commits intomainfrom
plan-result

Conversation

@tpoliaw
Copy link
Contributor

@tpoliaw tpoliaw commented Jan 27, 2026

This adds a result field to the task status in WorkerEvents.

BREAKING CHANGE: This changes the structure of the events sent during plans so will require external clients to be updated to match.

@tpoliaw tpoliaw linked an issue Jan 27, 2026 that may be closed by this pull request
@tpoliaw
Copy link
Contributor Author

tpoliaw commented Jan 27, 2026

This would need a matching change in GDA (back-ported to 9.38?) to add the result type to TaskStatus here.

Use pydantic to convert result to something that can be JSON serialized later.
@tpoliaw tpoliaw changed the title WIP returning results from plans Include plan return values in WorkerEvents Jan 29, 2026
@tpoliaw tpoliaw marked this pull request as ready for review January 29, 2026 16:15
@tpoliaw tpoliaw requested a review from a team as a code owner January 29, 2026 16:15
@tpoliaw
Copy link
Contributor Author

tpoliaw commented Jan 29, 2026

Ignoring the GDA change, I think the blueapi side of this is workable

@tpoliaw tpoliaw changed the title Include plan return values in WorkerEvents feat!: Include plan return values in WorkerEvents Jan 29, 2026
@tpoliaw
Copy link
Contributor Author

tpoliaw commented Jan 29, 2026

Change in gerrit: https://gerrit.diamond.ac.uk/c/gda/gda-core/+/44673

Copy link
Contributor

@DominicOram DominicOram left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks. Should: it would be nice to add some tests on the case where the plan is actually returning something, ideally parametrized against a few different return types.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Return plan_result to the client

2 participants